package sqlhelper

Import Path
	github.com/Golang-Tools/sqlhelper (on go.dev)

Dependency Relation
	imports 17 packages, and imported by 0 packages

Involved Source Files

	      excptions.go
	      options.go
	      proxy.go
Package-Level Type Names (total 5, in which 4 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Callback (func)
		Callback redis操作的回调函数

		As Inputs Of (at least one exported)
			func (*Proxy).Regist(cb Callback) error

	 type Option (interface)
		Option configures how we set up the connection.

		Methods (only one, which is exported)
			( T) Apply(*Options)
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*funcOption
		As Outputs Of (at least 10, all are exported)
			func WithConnMaxIdleTimeMS(ConnMaxIdleTimeMS int) Option
			func WithConnMaxLifetimeMS(ConnMaxLifetimeMS int) Option
			func WithDiscardUnknownColumns() Option
			func WithInstance(cli *bun.DB) Option
			func WithLogger(logger logrus.FieldLogger) Option
			func WithMaxIdleConns(MaxIdleConns int) Option
			func WithMaxOpenConns(MaxOpenConns int) Option
			func WithParallelCallback() Option
			func WithQueryTimeoutMS(QueryTimeout int) Option
			func WithURL(URL string) Option
		As Inputs Of (at least one exported)
			func (*Proxy).Init(opts ...Option) error

	 type Options (struct)
		Option 设置key行为的选项
		@attribute MaxTTL time.Duration 为0则不设置过期
		@attribute AutoRefresh string 需要为crontab格式的字符串,否则不会自动定时刷新

		Fields (total 10, all are exported)
			Cli *bun.DB
				// 只在Init方法中生效

			ConnMaxIdleTime time.Duration
			ConnMaxLifetime time.Duration
			DiscardUnknownColumns bool
			Logger logrus.FieldLogger
			MaxIdleConns int
			MaxOpenConns int
			Parallelcallback bool
				// 只在Init方法中生效

			QueryTimeout time.Duration
				// 只在Init方法中生效

			URL string
				// 只在Init方法中生效

		As Inputs Of (at least 3, all are exported)
			func NewDB(URL string, dopts *Options) (*bun.DB, error)
			func SetPool(sqldb *sql.DB, opts *Options)
			func Option.Apply(*Options)
		As Types Of (only one, which is exported)
			  var DefaultOpts

	 type Proxy (struct)
		Proxy bun客户端的代理

		Fields (total 31, in which 1 are exported)
			DB *bun.DB
			/* 30 unexporteds ... *//* 30 unexporteds: */
			callBacks []Callback
			DB.DB.cleanerCh chan struct{}
			DB.DB.closed bool
			DB.DB.connRequests map[uint64]chan sql.connRequest
			DB.DB.connector driver.Connector
			DB.DB.dep map[sql.finalCloser]sql.depSet
			DB.DB.freeConn []*sql.driverConn
			DB.DB.lastPut map[*sql.driverConn]string
				// stacktrace of last conn's put; debug only

			DB.DB.maxIdleClosed int64
				// Total number of connections closed due to idle count.

			DB.DB.maxIdleCount int
				// zero means defaultMaxIdleConns; negative means 0

			DB.DB.maxIdleTime time.Duration
				// maximum amount of time a connection may be idle before being closed

			DB.DB.maxIdleTimeClosed int64
				// Total number of connections closed due to idle time.

			DB.DB.maxLifetime time.Duration
				// maximum amount of time a connection may be reused

			DB.DB.maxLifetimeClosed int64
				// Total number of connections closed due to max connection lifetime limit.

			DB.DB.maxOpen int
				// <= 0 means unlimited

			DB.DB.mu sync.Mutex
				// protects following fields

			DB.DB.nextRequest uint64
				// Next key to use in connRequests.

			DB.DB.numClosed uint64
				numClosed is an atomic counter which represents a total number of
				closed connections. Stmt.openStmt checks it before cleaning closed
				connections in Stmt.css.

			DB.DB.numOpen int
				// number of opened and pending open connections

			DB.DB.openerCh chan struct{}
				Used to signal the need for new connections
				a goroutine running connectionOpener() reads on this chan and
				maybeOpenNewConnections sends on the chan (one send per needed connection)
				It is closed during db.Close(). The close tells the connectionOpener
				goroutine to exit.

			DB.DB.stop func()
				// stop cancels the connection opener.

			DB.DB.waitCount int64
				// Total number of connections waited for.

			DB.DB.waitDuration int64
				Atomic access only. At top of struct to prevent mis-alignment
				on 32-bit platforms. Of type time.Duration.
				// Total time waited for new connections.

			DB.dialect schema.Dialect
			DB.features feature.Feature
			DB.flags internal.Flag
			DB.fmter schema.Formatter
			DB.queryHooks []bun.QueryHook
			DB.stats bun.DBStats
			queryTimeout time.Duration
		Methods (total 82, in which 50 are exported)
			( T) AddQueryHook(hook bun.QueryHook)
			( T) Begin() (bun.Tx, error)
			( T) BeginTx(ctx context.Context, opts *sql.TxOptions) (bun.Tx, error)
			( T) Close() error
				Close closes the database and prevents new queries from starting.
				Close then waits for all queries that have started processing on the server
				to finish.

				It is rare to Close a DB, as the DB handle is meant to be
				long-lived and shared between many goroutines.

			( T) Conn(ctx context.Context) (bun.Conn, error)
			( T) DBStats() bun.DBStats
			( T) Dialect() schema.Dialect
			( T) Driver() driver.Driver
				Driver returns the database's underlying driver.

			( T) Exec(query string, args ...interface{}) (sql.Result, error)
			( T) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
			( T) Formatter() schema.Formatter
			(*T) Init(opts ...Option) error
				Init 初始化代理对象

			(*T) IsOk() bool
				IsOk 检查代理是否已经可用

			( T) NewAddColumn() *bun.AddColumnQuery
			( T) NewCreateIndex() *bun.CreateIndexQuery
			( T) NewCreateTable() *bun.CreateTableQuery
			(*T) NewCtx() (ctx context.Context, cancel context.CancelFunc)
				NewCtx 根据注册的超时时间构造一个上下文

			( T) NewDelete() *bun.DeleteQuery
			( T) NewDropColumn() *bun.DropColumnQuery
			( T) NewDropIndex() *bun.DropIndexQuery
			( T) NewDropTable() *bun.DropTableQuery
			( T) NewInsert() *bun.InsertQuery
			( T) NewSelect() *bun.SelectQuery
			( T) NewTruncateTable() *bun.TruncateTableQuery
			( T) NewUpdate() *bun.UpdateQuery
			( T) NewValues(model interface{}) *bun.ValuesQuery
			( T) Ping() error
				Ping verifies a connection to the database is still alive,
				establishing a connection if necessary.

			( T) PingContext(ctx context.Context) error
				PingContext verifies a connection to the database is still alive,
				establishing a connection if necessary.

			( T) Prepare(query string) (bun.Stmt, error)
			( T) PrepareContext(ctx context.Context, query string) (bun.Stmt, error)
			( T) Query(query string, args ...interface{}) (*sql.Rows, error)
			( T) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)
			( T) QueryRow(query string, args ...interface{}) *sql.Row
			( T) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row
			(*T) Regist(cb Callback) error
				Regist 注册回调函数,在init执行后执行回调函数
				如果对象已经设置了被代理客户端则无法再注册回调函数

			( T) RegisterModel(models ...interface{})
			( T) ResetModel(ctx context.Context, models ...interface{}) error
			( T) RunInTx(ctx context.Context, opts *sql.TxOptions, fn func(ctx context.Context, tx bun.Tx) error) error
				RunInTx runs the function in a transaction. If the function returns an error,
				the transaction is rolled back. Otherwise, the transaction is committed.

			( T) ScanRow(ctx context.Context, rows *sql.Rows, dest ...interface{}) error
			( T) ScanRows(ctx context.Context, rows *sql.Rows, dest ...interface{}) error
			( T) SetConnMaxIdleTime(d time.Duration)
				SetConnMaxIdleTime sets the maximum amount of time a connection may be idle.

				Expired connections may be closed lazily before reuse.

				If d <= 0, connections are not closed due to a connection's idle time.

			( T) SetConnMaxLifetime(d time.Duration)
				SetConnMaxLifetime sets the maximum amount of time a connection may be reused.

				Expired connections may be closed lazily before reuse.

				If d <= 0, connections are not closed due to a connection's age.

			(*T) SetConnect(cli *bun.DB, parallelcallback bool) error
				SetConnect 设置连接的客户端
				@params cli *bun.DB bun的DB对象

			( T) SetMaxIdleConns(n int)
				SetMaxIdleConns sets the maximum number of connections in the idle
				connection pool.

				If MaxOpenConns is greater than 0 but less than the new MaxIdleConns,
				then the new MaxIdleConns will be reduced to match the MaxOpenConns limit.

				If n <= 0, no idle connections are retained.

				The default max idle connections is currently 2. This may change in
				a future release.

			( T) SetMaxOpenConns(n int)
				SetMaxOpenConns sets the maximum number of open connections to the database.

				If MaxIdleConns is greater than 0 and the new MaxOpenConns is less than
				MaxIdleConns, then MaxIdleConns will be reduced to match the new
				MaxOpenConns limit.

				If n <= 0, then there is no limit on the number of open connections.
				The default is 0 (unlimited).

			(*T) SetQueryTimeout(timeout time.Duration)
				SetQueryTimeout 设置连接的请求超时
				@params timeout time.Duration

			( T) Stats() sql.DBStats
				Stats returns database statistics.

			( T) String() string
			( T) Table(typ reflect.Type) *schema.Table
			( T) WithNamedArg(name string, value interface{}) *bun.DB
			/* 32 unexporteds ... *//* 32 unexporteds: */
			( T) addDep(x sql.finalCloser, dep interface{})
				addDep notes that x now depends on dep, and x's finalClose won't be
				called until all of x's dependencies are removed with removeDep.

			( T) addDepLocked(x sql.finalCloser, dep interface{})
			( T) afterQuery(ctx context.Context, event *bun.QueryEvent, res sql.Result, err error)
			( T) afterQueryFromIndex(ctx context.Context, event *bun.QueryEvent, hookIndex int)
			( T) beforeQuery(ctx context.Context, queryApp schema.Query, query string, queryArgs []interface{}) (context.Context, *bun.QueryEvent)
			( T) begin(ctx context.Context, opts *sql.TxOptions, strategy sql.connReuseStrategy) (tx *sql.Tx, err error)
			( T) beginDC(ctx context.Context, dc *sql.driverConn, release func(error), opts *sql.TxOptions) (tx *sql.Tx, err error)
				beginDC starts a transaction. The provided dc must be valid and ready to use.

			( T) clone() *bun.DB
			( T) conn(ctx context.Context, strategy sql.connReuseStrategy) (*sql.driverConn, error)
				conn returns a newly-opened or cached *driverConn.

			( T) connectionCleaner(d time.Duration)
			( T) connectionCleanerRunLocked() (closing []*sql.driverConn)
			( T) connectionOpener(ctx context.Context)
				Runs in a separate goroutine, opens new connections when requested.

			( T) exec(ctx context.Context, query string, args []interface{}, strategy sql.connReuseStrategy) (sql.Result, error)
			( T) execDC(ctx context.Context, dc *sql.driverConn, release func(error), query string, args []interface{}) (res sql.Result, err error)
			( T) format(query string, args []interface{}) string
			( T) makeQueryBytes() []byte
			( T) maxIdleConnsLocked() int
			( T) maybeOpenNewConnections()
				Assumes db.mu is locked.
				If there are connRequests and the connection limit hasn't been reached,
				then tell the connectionOpener to open new connections.

			( T) nextRequestKeyLocked() uint64
				nextRequestKeyLocked returns the next connection request key.
				It is assumed that nextRequest will not overflow.

			( T) noteUnusedDriverStatement(c *sql.driverConn, ds *sql.driverStmt)
				noteUnusedDriverStatement notes that ds is no longer used and should
				be closed whenever possible (when c is next not in use), unless c is
				already closed.

			( T) openNewConnection(ctx context.Context)
				Open one new connection

			( T) pingDC(ctx context.Context, dc *sql.driverConn, release func(error)) error
			( T) prepare(ctx context.Context, query string, strategy sql.connReuseStrategy) (*sql.Stmt, error)
			( T) prepareDC(ctx context.Context, dc *sql.driverConn, release func(error), cg sql.stmtConnGrabber, query string) (*sql.Stmt, error)
				prepareDC prepares a query on the driverConn and calls release before
				returning. When cg == nil it implies that a connection pool is used, and
				when cg != nil only a single driver connection is used.

			( T) putConn(dc *sql.driverConn, err error, resetSession bool)
				putConn adds a connection to the db's free pool.
				err is optionally the last error that occurred on this connection.

			( T) putConnDBLocked(dc *sql.driverConn, err error) bool
				Satisfy a connRequest or put the driverConn in the idle pool and return true
				or return false.
				putConnDBLocked will satisfy a connRequest if there is one, or it will
				return the *driverConn to the freeConn list if err == nil and the idle
				connection limit will not be exceeded.
				If err != nil, the value of dc is ignored.
				If err == nil, then dc must not equal nil.
				If a connRequest was fulfilled or the *driverConn was placed in the
				freeConn list, then true is returned, otherwise false is returned.

			( T) query(ctx context.Context, query string, args []interface{}, strategy sql.connReuseStrategy) (*sql.Rows, error)
			( T) queryDC(ctx, txctx context.Context, dc *sql.driverConn, releaseConn func(error), query string, args []interface{}) (*sql.Rows, error)
				queryDC executes a query on the given connection.
				The connection gets released by the releaseConn function.
				The ctx context is from a query method and the txctx context is from an
				optional transaction context.

			( T) removeDep(x sql.finalCloser, dep interface{}) error
				removeDep notes that x no longer depends on dep.
				If x still has dependencies, nil is returned.
				If x no longer has any dependencies, its finalClose method will be
				called and its error value will be returned.

			( T) removeDepLocked(x sql.finalCloser, dep interface{}) func() error
			( T) shortestIdleTimeLocked() time.Duration
			( T) startCleanerLocked()
				startCleanerLocked starts connectionCleaner if needed.

		Implements (at least 7, in which 4 are exported)
			 T : github.com/uptrace/bun.IConn
			 T : github.com/uptrace/bun.IDB
			 T : fmt.Stringer
			 T : io.Closer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			 T : context.stringer
			 T : os/signal.stringer
			 T : runtime.stringer
		As Outputs Of (at least one exported)
			func New() *Proxy
		As Types Of (only one, which is exported)
			  var DB *Proxy

	/* one unexported ... *//* one unexported: */
	 type funcOption (struct)
		func (emptyOption) apply(*Options) {}

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			f func(*Options)
		Methods (only one, which is exported)
			(*T) Apply(do *Options)
		Implements (at least one exported)
			*T : Option
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newFuncOption(f func(*Options)) *funcOption


Package-Level Functions (total 14, in which 13 are exported)

	 func New() *Proxy
		New 创建一个新的数据库客户端代理

	 func NewDB(URL string, dopts *Options) (*bun.DB, error)
	 func SetPool(sqldb *sql.DB, opts *Options)
		SetPool 设置连接池信息

	 func WithConnMaxIdleTimeMS(ConnMaxIdleTimeMS int) Option
		WithConnMaxIdleTimeMS 设置连接池的最大空闲连接超时时间,单位ms

	 func WithConnMaxLifetimeMS(ConnMaxLifetimeMS int) Option
		WithConnMaxLifetimeMS 设置连接池的最大连接超时时间,单位ms

	 func WithDiscardUnknownColumns() Option
		WithDiscardUnknownColumns 设置当有未知列时不报错

	 func WithInstance(cli *bun.DB) Option
	 func WithLogger(logger logrus.FieldLogger) Option
		WithLogger 用于添加logger方便debug

	 func WithMaxIdleConns(MaxIdleConns int) Option
		WithMaxIdleConns 设置连接池的最大空闲连接数

	 func WithMaxOpenConns(MaxOpenConns int) Option
		WithMaxOpenConns 设置连接池的最大连接数

	 func WithParallelCallback() Option
		WithParallelCallback 设置初始化后回调并行执行而非串行执行

	 func WithQueryTimeoutMS(QueryTimeout int) Option
		WithQueryTimeoutMS 设置最大请求超时,单位ms

	 func WithURL(URL string) Option
		WithURL 使用要连接的数据库管理系统的url

	/* one unexported ... *//* one unexported: */
	 func newFuncOption(f func(*Options)) *funcOption
Package-Level Variables (total 6, all are exported)

	  var DB *Proxy
		DB 默认的数据库代理对象

	  var DefaultOpts Options
	  var ErrProxyAllreadySettedUniversalClient error
		ErrProxyAllreadySettedUniversalClient 代理已经设置过redis客户端对象

	  var ErrProxyNotYetSettedUniversalClient error
		ErrProxyNotYetSettedUniversalClient 代理还未设置客户端对象

	  var ErrUnknownClientType error
		ErrUnknownClientType 未知的redis客户端类型

	  var ErrUnSupportSchema error
		ErrUnSupportSchema 未支持的数据库管理服务类型

The pages are generated with Golds v0.3.6. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.